/*
 * Copyright (c) 2021 0x1abin
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */

#ifndef _MULTI_TASK_H_
#define _MULTI_TASK_H_


#ifdef __cplusplus  
extern "C" {  
#endif

typedef unsigned int MultiTaskCnt_t ; 

typedef struct MultiTaskHandle MultiTask;

#ifdef __SDCC
//51下需要特殊处理
typedef void (*MultiTaskCallback_t)(MultiTask* task, void* userData) __reentrant ;  
#else 
typedef void (*MultiTaskCallback_t)(MultiTask* task, void* userData) ;
#endif 

struct MultiTaskHandle {
    MultiTask* next;
    MultiTaskCnt_t deadline;
    MultiTaskCnt_t tik ; 
    MultiTaskCallback_t callback ;
    void* userData;
};



/**
 * @brief Start the task work, add the handle into work list.
 * 
 * @param task target handle strcut.
 * @param timing Set the start time.
 * @param callback deadline callback.
 * @param userData user data.
 * @return int 0: success, -1: fail.
 */
int MultiTaskStart(MultiTask* task, MultiTaskCnt_t timing, MultiTaskCallback_t callback, void* userData);

/**
 * @brief Stop the task work, remove the handle off work list.
 * 
 * @param task target handle strcut.
 * @return int 0: success, -1: fail.
 */
int MultiTaskStop(MultiTask* task);

/**
 * @brief Check the task expried and call callback.
 * 
 * @return int The next task expires.
 */
int MultiTaskYield(void);

#ifdef __cplusplus
} 
#endif

#endif
